认证与配置 API
本文档涵盖认证(/api/v1/auth)与配置(/api/v1/config)两组接口。
认证 · 用户注册
POST /api/v1/auth/register
将用户信息写入本地数据库。
请求参数(JSON)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
username | string | ✅ | 用户名(1~50 字符) |
phone | string | ✅ | 手机号(7~15 位数字) |
identity | string | ✅ | 身份 / 角色(1~100 字符) |
请求示例
json
{
"username": "张三",
"phone": "13800000000",
"identity": "教师"
}响应示例
json
{
"message": "注册成功"
}配置 · 获取配置
GET /api/v1/config
获取当前配置。
响应示例
json
{
"config": {
"server": {
"host": "127.0.0.1",
"port": 7410
},
"paths": {},
"dev_mode": false
}
}配置 · 更新配置
POST /api/v1/config
更新配置并保存。仅允许修改 server、paths、dev_mode 三个顶层配置项。
请求参数(JSON)
json
{
"server": { "port": 7411 },
"dev_mode": true
}校验规则
- 顶层仅允许
server、paths、dev_mode三个键,出现其他键时返回400(不允许的配置项)。 - 嵌套字典配置(如
server)会与现有配置合并更新。
响应示例
json
{
"config": {
"server": {
"host": "127.0.0.1",
"port": 7411
},
"paths": {},
"dev_mode": true
}
}
豫公网安备41048202000209号